---
title: 排序
icon: ArrowUpNarrowWide
---

<MetaData
  lang="zh-CN"
  meta={{
    preset: [{
      client: '@univerjs/preset-sheets-sort',
      locale: '@univerjs/preset-sheets-sort/locales/zh-CN',
      style: '@univerjs/preset-sheets-sort/lib/index.css',
    }],
    plugins: [{
      client: '@univerjs/sheets-sort',
      facade: '@univerjs/sheets-sort/facade',
    }, {
      client: '@univerjs/sheets-sort-ui',
      locale: '@univerjs/sheets-sort-ui/locale/zh-CN',
      style: '@univerjs/sheets-sort-ui/lib/index.css',
    }],
    server: '否',
  }}
/>

排序功能允许用户对电子表格中的数据进行排序，以便更好地组织和分析信息。它支持多种排序方式，包括升序、降序和自定义排序，帮助用户快速找到所需数据。

## 预设模式

### 安装

```package-install
npm install @univerjs/preset-sheets-sort
```

### 使用

```typescript
import { UniverSheetsCorePreset } from '@univerjs/preset-sheets-core'
import UniverPresetSheetsCoreZhCN from '@univerjs/preset-sheets-core/locales/zh-CN'
import { UniverSheetsSortPreset } from '@univerjs/preset-sheets-sort' // [!code ++]
import UniverPresetSheetsSortZhCN from '@univerjs/preset-sheets-sort/locales/zh-CN' // [!code ++]
import { createUniver, LocaleType, mergeLocales } from '@univerjs/presets'

import '@univerjs/preset-sheets-core/lib/index.css'
import '@univerjs/preset-sheets-sort/lib/index.css' // [!code ++]

const { univerAPI } = createUniver({
  locale: LocaleType.ZH_CN,
  locales: {
    [LocaleType.ZH_CN]: mergeLocales(
      UniverPresetSheetsCoreZhCN,
      UniverPresetSheetsSortZhCN, // [!code ++]
    ),
  },
  presets: [
    UniverSheetsCorePreset(),
    UniverSheetsSortPreset(), // [!code ++]
  ],
})
```

{/* ### 预设与配置 */}

## 插件模式

### 安装

```package-install
npm install @univerjs/sheets-sort @univerjs/sheets-sort-ui
```

### 使用

```typescript
import { LocaleType, mergeLocales, Univer } from '@univerjs/core'
import { UniverSheetsSortPlugin } from '@univerjs/sheets-sort' // [!code ++]
import { UniverSheetsSortUIPlugin } from '@univerjs/sheets-sort-ui' // [!code ++]
import SheetsSortUIZhCN from '@univerjs/sheets-sort-ui/locale/zh-CN' // [!code ++]

import '@univerjs/sheets-sort-ui/lib/index.css' // [!code ++]

import '@univerjs/sheets-sort/facade' // [!code ++]

const univer = new Univer({
  locale: LocaleType.ZH_CN,
  locales: {
    [LocaleType.ZH_CN]: mergeLocales(
      SheetsSortUIZhCN, // [!code ++]
    ),
  },
})

univer.registerPlugin(UniverSheetsSortPlugin) // [!code ++]
univer.registerPlugin(UniverSheetsSortUIPlugin) // [!code ++]
```

{/* ### 插件与配置 */}

## Facade API

完整 Facade API 类型定义，请查看 [FacadeAPI](https://reference.univer.ai/zh-CN)

### 工作表排序

[`FWorksheet.sort(colIndex, asc)`](https://reference.univer.ai/zh-CN/classes/FWorksheet#sort) 方法可以按指定的列对工作表进行排序。

```typescript
const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()

// 按照第一列升序排序工作表
fWorksheet.sort(0)

// 按照第一列降序排序工作表
fWorksheet.sort(0, false)
```

### 区域排序

[`FRange.sort(column)`](https://reference.univer.ai/zh-CN/classes/FRange#sort) 方法可以按指定的列和顺序对给定范围内的单元格进行排序。

```typescript
const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()
const fRange = fWorksheet.getRange('D1:G10')

// 按照第一列升序排序区域
fRange.sort(0)

// 按照第一列降序排序区域
fRange.sort({ column: 0, ascending: false })

// 按照第一列降序，第二列升序排序区域
fRange.sort([{ column: 0, ascending: false }, 1])
```

### 事件监听

完整事件类型定义，请查看 [Events](https://reference.univer.ai/zh-CN/classes/FEventName)。

`SheetRangeSorted` 事件在单元格范围排序完成后触发。

```typescript
const disposable = univerAPI.addEvent(univerAPI.Event.SheetRangeSorted, (params) => {
  const { workbook, worksheet, range, sortColumn } = params
})

// 移除事件监听器，使用 `disposable.dispose()`
```

`SheetBeforeRangeSort` 事件在单元格范围排序前触发。

```typescript
const disposable = univerAPI.addEvent(univerAPI.Event.SheetBeforeRangeSort, (params) => {
  const { workbook, worksheet, range, sortColumn } = params

  // 取消排序操作
  params.cancel = true
})

// 移除事件监听器，使用 `disposable.dispose()`
```
